feat: added DisabledVault to disable id-cache when noFunctional is set by jaissica12 · Pull Request #1072 · mParticle/mparticle-web-sdk

jaissica12 · 2025-09-17T15:16:06Z

Instructions

PR target branch should be against development
PR title name should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-title-check.yml
PR branch prefix should follow this format: https://github.com/mParticle/mparticle-workflows/blob/main/.github/workflows/pr-branch-check-name.yml

Summary

Created a new DisabledVault which is used when noFunctional is set true.
Added jest and integration tests for it

Testing Plan

Was this tested locally? If not, explain why.
{explain how this has been tested, and what, if any, additional testing should be done}

Reference Issue (For mParticle employees only. Ignore if you are an outside contributor)

Closes https://rokt.atlassian.net/browse/SDKE-132

…when-no-functional-is-true

rmi22186 · 2025-09-18T21:50:29Z

-    });
+    const cacheKey = `${mpInstance._Store.storageName}-id-cache`;
+    if (mpInstance._Store.getNoFunctional()) {
+        console.log('createIdentityCache: noFunctional is true');


remove

Suggested change

console.log('createIdentityCache: noFunctional is true');

rmi22186 · 2025-09-18T22:17:17Z

+        });
+
+        describe('#createIdentityCache', function() {
+            it('should use LocalStorageVault when noFunctional is false by default', async () => {


you aren't really confirming that the vault is or isn't localstorage vs disablevault.

rmi22186

minor edits. also needs to be rebased against #1063 and logic need to be updated using mpInstance._Store.getPrivacyFlag

rmi22186 · 2025-09-18T22:18:05Z

+        });
+
+        describe('#createIdentityCache', function() {
+            it('should use LocalStorageVault when noFunctional is false by default', async () => {


Suggested change

it('should use LocalStorageVault when noFunctional is false by default', async () => {

it('should save id cache to local storage when noFunctional is false by default', async () => {

rmi22186 · 2025-09-18T22:18:23Z

+                expect(localStorage.getItem('mprtcl-v4_abcdef-id-cache')).to.be.ok;
+            });
+
+            it('should use DisabledVault when noFunctional is true', async () => {


Suggested change

it('should use DisabledVault when noFunctional is true', async () => {

it('should NOT save id cache to local storage when noFunctional is true', async () => {

rmi22186 · 2025-09-18T22:18:44Z

+            });
+
+            it('should use DisabledVault when noFunctional is true', async () => {
+                mParticle.config.noFunctional = true;


Suggested change

mParticle.config.noFunctional = true;

mParticle.config.launcherOptions = {noFunctional: true};

@rmi22186 Currently noFunctional / noTargeting is only read from top‑level mParticle.config during init, not from config.launcherOptions that is why mParticle.config.noTargeting = true; works. To use mParticle.config.launcherOptions = {noTargeting: true}; we need to update store to source privacy flags from config.launcherOptions.

this will need to be updated once you sync this branch with development after the #1064 (review) is merged

rmi22186 · 2025-09-18T22:19:14Z

+                expect(localStorage.getItem('mprtcl-v4_abcdef-id-cache')).not.to.be.ok;
+            });
+
+            it('should use LocalStorageVault when noFunctional is false', async () => {


Suggested change

it('should use LocalStorageVault when noFunctional is false', async () => {

it('should save id cache to local storage when noFunctional is false', async () => {

rmi22186 · 2025-09-18T22:23:12Z

+        describe('#store', () => {
+            it('should NOT write to localStorage', () => {
+                const storageKey = 'test-disabled-store-empty';
+                const vault = new DisabledVault<Dictionary<Dictionary<string>>>(


seems overly complicated to use the Dictionary<Dictionary<string>>> type and testObject. maybe just make things simpler and shorter by using testString here and throughout the tests below

rmi22186 · 2025-09-18T22:25:03Z

+                );
+
+                vault.purge();
+                console.log(window.localStorage.getItem(storageKey));


Suggested change

console.log(window.localStorage.getItem(storageKey));

…disable-identity-cache-when-no-functional-is-true

sonarqubecloud · 2025-09-23T17:47:28Z

Quality Gate passed

Issues
13 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

# [2.47.0](v2.46.0...v2.47.0) (2025-10-01) ### Bug Fixes * SDKE-317 Call deferred methods on Rokt Manager instead of kit ([#1076](#1076)) ([3a0643b](3a0643b)) ### Features * added DisabledVault to disable id-cache when noFunctional is set ([#1072](#1072)) ([8187d72](8187d72)) * added noFunctional in batchUploader to disable offline storage ([#1063](#1063)) ([97dd88a](97dd88a)) * disable session cookie/localStorage when noFunctional is set ([#1070](#1070)) ([edb2e61](edb2e61)) * disable time tracking when noTargeting is set to true ([#1064](#1064)) ([71c891c](71c891c))

mparticle-automation · 2025-10-01T20:08:27Z

🎉 This PR is included in version 2.47.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

feat: added DisabledVault to disable id-cache when noFunctional is set

c477466

jaissica12 requested review from alexs-mparticle and rmi22186 September 17, 2025 16:38

Merge branch 'development' into feat/sdke-132-disable-identity-cache-…

f31395b

…when-no-functional-is-true

rmi22186 reviewed Sep 18, 2025

View reviewed changes

rmi22186 requested changes Sep 18, 2025

View reviewed changes

jaissica12 added 2 commits September 19, 2025 15:43

Merge remote-tracking branch 'origin/development' into feat/sdke-132-…

2b2e795

…disable-identity-cache-when-no-functional-is-true

test: updated tests for DisabledVault

288e259

jaissica12 requested a review from rmi22186 September 19, 2025 20:16

jaissica12 added 4 commits September 19, 2025 16:17

chore: removed log statement

9cf89ed

refactor: updated getPrivacyFlag for identity cache

b961fe8

Merge remote-tracking branch 'origin/development' into feat/sdke-132-…

e86d69b

…disable-identity-cache-when-no-functional-is-true

test: source privacy flag from launcherOptions

cba8679

rmi22186 approved these changes Sep 23, 2025

View reviewed changes

jaissica12 merged commit 8187d72 into development Sep 24, 2025
135 of 149 checks passed

mparticle-automation added the released label Oct 1, 2025

	it('should use LocalStorageVault when noFunctional is false by default', async () => {
	it('should save id cache to local storage when noFunctional is false by default', async () => {

	it('should use DisabledVault when noFunctional is true', async () => {
	it('should NOT save id cache to local storage when noFunctional is true', async () => {

	mParticle.config.noFunctional = true;
	mParticle.config.launcherOptions = {noFunctional: true};

Uh oh!

Conversation

jaissica12 commented Sep 17, 2025

Instructions

Summary

Testing Plan

Reference Issue (For mParticle employees only. Ignore if you are an outside contributor)

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rmi22186 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Sep 23, 2025

Quality Gate passed

Uh oh!

Uh oh!

mparticle-automation commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants